'\" et
.TH STRTOIMAX "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.\"
.SH NAME
strtoimax,
strtoumax
\(em convert string to integer type
.SH SYNOPSIS
.LP
.nf
#include <inttypes.h>
.P
intmax_t strtoimax(const char *restrict \fInptr\fP, char **restrict \fIendptr\fP,
    int \fIbase\fP);
uintmax_t strtoumax(const char *restrict \fInptr\fP, char **restrict \fIendptr\fP,
    int \fIbase\fP);
.fi
.SH DESCRIPTION
The functionality described on this reference page is aligned with the
ISO\ C standard. Any conflict between the requirements described here and the
ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
.P
These functions shall be equivalent to the
\fIstrtol\fR(),
\fIstrtoll\fR(),
\fIstrtoul\fR(),
and
\fIstrtoull\fR()
functions, except that the initial portion of the string shall be
converted to
.BR intmax_t
and
.BR uintmax_t
representation, respectively.
.SH "RETURN VALUE"
These functions shall return the converted value, if any.
.P
If no conversion could be performed, zero shall be returned
and
.IR errno
may be set to
.BR [EINVAL] .
.P
If the value of
.IR base
is not supported, 0 shall be returned and
.IR errno
shall be set to
.BR [EINVAL] .
.P
If the correct value is outside the range of representable values,
{INTMAX_MAX},
{INTMAX_MIN},
or
{UINTMAX_MAX}
shall be returned (according to the return type and sign of the value,
if any), and
.IR errno
shall be set to
.BR [ERANGE] .
.SH ERRORS
These functions shall fail if:
.TP
.BR EINVAL
The value of
.IR base
is not supported.
.TP
.BR ERANGE
The value to be returned is not representable.
.P
These functions may fail if:
.TP
.BR EINVAL
No conversion could be performed.
.LP
.IR "The following sections are informative."
.SH EXAMPLES
None.
.SH "APPLICATION USAGE"
Since the value of
.IR *endptr
is unspecified if the value of
.IR base
is not supported, applications should either ensure that
.IR base
has a supported value (0 or between 2 and 36) before the call, or check
for an
.BR [EINVAL] 
error before examining
.IR *endptr .
.SH RATIONALE
None.
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "\fIstrtol\fR\^(\|)",
.IR "\fIstrtoul\fR\^(\|)"
.P
The Base Definitions volume of POSIX.1\(hy2017,
.IR "\fB<inttypes.h>\fP"
.\"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1-2017, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, 2018 Edition,
Copyright (C) 2018 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html .
.PP
Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .
